/*
 * Copyright 2012-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.context.properties;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.context.annotation.Import;
import org.springframework.core.annotation.AliasFor;
import org.springframework.stereotype.Component;

/**
 * 配置扫描 {@link ConfigurationProperties @ConfigurationProperties} 类时使用的基础包。
 * 可以指定 {@link #basePackageClasses()}、{@link #basePackages()} 或其别名 {@link #value()}
 * 中的一个来定义特定的扫描包。如果未定义特定包，则从带有此注解的类所在包开始扫描。
 * <p>
 * 注意：带有或元注解 {@link Component @Component} 的类不会被此注解扫描到。
 *
 * @author Madhura Bhave
 * @since 2.2.0
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(ConfigurationPropertiesScanRegistrar.class)
@EnableConfigurationProperties
public @interface ConfigurationPropertiesScan {

	/**
	 * {@link #basePackages()} 属性的别名。允许更简洁的注解声明，例如：
	 * {@code @ConfigurationPropertiesScan("org.my.pkg")}，
	 * 代替 {@code @ConfigurationPropertiesScan(basePackages="org.my.pkg")}。
	 * @return 要扫描的基础包
	 */
	@AliasFor("basePackages")
	String[] value() default {};

	/**
	 * 要扫描配置属性的基础包。{@link #value()} 是此属性的别名（两者互斥）。
	 * <p>
	 * 使用 {@link #basePackageClasses()} 作为基于字符串包名的类型安全替代方案。
	 * @return 要扫描的基础包
	 */
	@AliasFor("value")
	String[] basePackages() default {};

	/**
	 * 指定要扫描配置属性的包的类型安全替代方式，扫描每个指定类所在的包。
	 * <p>
	 * 考虑在每个包中创建一个特殊的无操作标记类或接口，仅作为此属性的引用用途。
	 * @return 来自要扫描基础包的类
	 */
	Class<?>[] basePackageClasses() default {};

}
